1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module shumate.TileDownloader;
26 
27 private import glib.ConstructionException;
28 private import glib.Str;
29 private import gobject.ObjectG;
30 private import shumate.DataSource;
31 private import shumate.c.functions;
32 public  import shumate.c.types;
33 
34 
35 /**
36  * A [class@Shumate.DataSource] that asynchronously downloads tiles from an online
37  * service using a given template.
38  * 
39  * It contains an internal [class@Shumate.FileCache] to cache the tiles on the system.
40  */
41 public class TileDownloader : DataSource
42 {
43 	/** the main Gtk struct */
44 	protected ShumateTileDownloader* shumateTileDownloader;
45 
46 	/** Get the main Gtk struct */
47 	public ShumateTileDownloader* getTileDownloaderStruct(bool transferOwnership = false)
48 	{
49 		if (transferOwnership)
50 			ownedRef = false;
51 		return shumateTileDownloader;
52 	}
53 
54 	/** the main Gtk struct as a void* */
55 	protected override void* getStruct()
56 	{
57 		return cast(void*)shumateTileDownloader;
58 	}
59 
60 	/**
61 	 * Sets our main struct and passes it to the parent class.
62 	 */
63 	public this (ShumateTileDownloader* shumateTileDownloader, bool ownedRef = false)
64 	{
65 		this.shumateTileDownloader = shumateTileDownloader;
66 		super(cast(ShumateDataSource*)shumateTileDownloader, ownedRef);
67 	}
68 
69 
70 	/** */
71 	public static GType getType()
72 	{
73 		return shumate_tile_downloader_get_type();
74 	}
75 
76 	/**
77 	 * Creates a new [class@TileDownloader] that fetches tiles from an API and
78 	 * caches them on disk.
79 	 *
80 	 * See [property@TileDownloader:url-template] for the format of the URL template.
81 	 *
82 	 * Params:
83 	 *     urlTemplate = a URL template to fetch tiles from
84 	 *
85 	 * Returns: a newly constructed [class@TileDownloader]
86 	 *
87 	 * Throws: ConstructionException GTK+ fails to create the object.
88 	 */
89 	public this(string urlTemplate)
90 	{
91 		auto __p = shumate_tile_downloader_new(Str.toStringz(urlTemplate));
92 
93 		if(__p is null)
94 		{
95 			throw new ConstructionException("null returned by new");
96 		}
97 
98 		this(cast(ShumateTileDownloader*) __p, true);
99 	}
100 }